<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content=
    "application/xhtml+xml; charset=iso-8859-1" />
    <title>
      GTK-Doc-1.32
    </title>
    <link rel="stylesheet" type="text/css" href="../stylesheets/lfs.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
    <link rel="stylesheet" href="../stylesheets/lfs-print.css" type=
    "text/css" media="print" />
  </head>
  <body class="blfs" id="blfs-9.1">
    <div class="navheader">
      <h4>
        Beyond Linux<sup>�</sup> From Scratch <span class="phrase">(System
        V</span> Edition) - Version 9.1
      </h4>
      <h3>
        Chapter&nbsp;11.&nbsp;General Utilities
      </h3>
      <ul>
        <li class="prev">
          <a accesskey="p" href="graphviz.html" title=
          "Graphviz-2.42.3">Prev</a>
          <p>
            Graphviz-2.42.3
          </p>
        </li>
        <li class="next">
          <a accesskey="n" href="hd2u.html" title="Hd2u-1.0.4">Next</a>
          <p>
            Hd2u-1.0.4
          </p>
        </li>
        <li class="up">
          <a accesskey="u" href="genutils.html" title=
          "Chapter&nbsp;11.&nbsp;General Utilities">Up</a>
        </li>
        <li class="home">
          <a accesskey="h" href="../index.html" title=
          "Beyond Linux� From Scratch     (System V Edition) - Version 9.1">Home</a>
        </li>
      </ul>
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <h1 class="sect1">
        <a id="gtk-doc" name="gtk-doc"></a>GTK-Doc-1.32
      </h1>
      <div class="package" lang="en" xml:lang="en">
        <h2 class="sect2">
          Introduction to GTK-Doc
        </h2>
        <p>
          The <span class="application">GTK-Doc</span> package contains a
          code documenter. This is useful for extracting specially formatted
          comments from the code to create API documentation. This package is
          <span class="emphasis"><em>optional</em></span>; if it is not
          installed, packages will not build the documentation. This does not
          mean that you will not have any documentation. If <span class=
          "application">GTK-Doc</span> is not available, the install process
          will copy any pre-built documentation to your system.
        </p>
        <p>
          This package is known to build and work properly using an LFS-9.1
          platform.
        </p>
        <h3>
          Package Information
        </h3>
        <div class="itemizedlist">
          <ul class="compact">
            <li class="listitem">
              <p>
                Download (HTTP): <a class="ulink" href=
                "http://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.32/gtk-doc-1.32.tar.xz">
                http://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.32/gtk-doc-1.32.tar.xz</a>
              </p>
            </li>
            <li class="listitem">
              <p>
                Download (FTP): <a class="ulink" href=
                "ftp://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.32/gtk-doc-1.32.tar.xz">
                ftp://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.32/gtk-doc-1.32.tar.xz</a>
              </p>
            </li>
            <li class="listitem">
              <p>
                Download MD5 sum: 07764836262e154e94922e5f2aa476ae
              </p>
            </li>
            <li class="listitem">
              <p>
                Download size: 748 KB
              </p>
            </li>
            <li class="listitem">
              <p>
                Estimated disk space required: 14 MB (with tests)
              </p>
            </li>
            <li class="listitem">
              <p>
                Estimated build time: 0.2 SBU (with tests)
              </p>
            </li>
          </ul>
        </div>
        <h3>
          GTK-Doc Dependencies
        </h3>
        <h4>
          Required
        </h4>
        <p class="required">
          <a class="xref" href="../pst/docbook.html" title=
          "docbook-xml-4.5">docbook-xml-4.5</a>, <a class="xref" href=
          "../pst/docbook-xsl.html" title=
          "docbook-xsl-nons-1.79.2">docbook-xsl-1.79.2</a>, <a class="xref"
          href="../pst/itstool.html" title="itstool-2.0.6">itstool-2.0.6</a>,
          and <a class="xref" href="libxslt.html" title=
          "libxslt-1.1.34">libxslt-1.1.34</a>
        </p>
        <h4>
          Recommended
        </h4>
        <p class="recommended">
          <a class="xref" href="python-modules.html#pygments" title=
          "Pygments-2.5.2">Pygments-2.5.2</a> at run time
        </p>
        <h4>
          Optional
        </h4>
        <p class="optional">
          For tests: <a class="ulink" href=
          "http://sourceforge.net/projects/dblatex/">dblatex</a> or <a class=
          "xref" href="../pst/fop.html" title="fop-2.4">fop-2.4</a> (XML PDF
          support), <a class="xref" href="glib2.html" title=
          "GLib-2.62.4">GLib-2.62.4</a>, <a class="xref" href="which.html"
          title="Which-2.21 and Alternatives">Which-2.21</a>, and Python
          modules <a class="xref" href="python-modules.html#lxml" title=
          "lxml-4.5.0">lxml-4.5.0</a>, <a class="ulink" href=
          "https://anytree.readthedocs.io/en/latest/">anytree</a>, and
          <a class="ulink" href=
          "https://pypi.org/project/parameterized/">parameterized</a>
        </p>
        <div class="admon note">
          <img alt="[Note]" src="../images/note.png" />
          <h3>
            Note
          </h3>
          <p>
            The optional python modules above can be easily installed with
            the <span class="command"><strong>pip3</strong></span> command.
          </p>
        </div>
        <p class="usernotes">
          User Notes: <a class="ulink" href=
          "http://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc">http://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc</a>
        </p>
      </div>
      <div class="installation" lang="en" xml:lang="en">
        <h2 class="sect2">
          Installation of GTK-Doc
        </h2>
        <p>
          Install <span class="application">GTK-Doc</span> by running the
          following commands:
        </p>
        <pre class="userinput">
<kbd class="command">./configure --prefix=/usr &amp;&amp;
make</kbd>
</pre>
        <p>
          The test suite will hang if the package (or a previous version) is
          not already installed.
        </p>
        <p>
          Now, as the <code class="systemitem">root</code> user:
        </p>
        <pre class="root">
<kbd class="command">make install</kbd>
</pre>
        <p>
          To test the results, issue: <span class="command"><strong>make
          check</strong></span>. Some tests will fail depending on optionally
          installed packages.
        </p>
      </div>
      <div class="content" lang="en" xml:lang="en">
        <h2 class="sect2">
          Contents
        </h2>
        <div class="segmentedlist">
          <div class="seglistitem">
            <div class="seg">
              <strong class="segtitle">Installed Programs:</strong>
              <span class="segbody">gtkdocize, gtkdoc-check, gtkdoc-depscan,
              gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkhtml2,
              gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan, and
              gtkdoc-scangobj</span>
            </div>
            <div class="seg">
              <strong class="segtitle">Installed Libraries:</strong>
              <span class="segbody">None</span>
            </div>
            <div class="seg">
              <strong class="segtitle">Installed Directories:</strong>
              <span class="segbody">/usr/share/gtk-doc and
              /usr/share/help/*/gtk-doc-manual</span>
            </div>
          </div>
        </div>
        <div class="variablelist">
          <h3>
            Short Descriptions
          </h3>
          <table border="0" class="variablelist">
            <colgroup>
              <col align="left" valign="top" />
              <col />
            </colgroup>
            <tbody>
              <tr>
                <td>
                  <p>
                    <a id="gtkdoc" name="gtkdoc"></a><span class=
                    "term"><span class=
                    "command"><strong>gtkdoc*</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    these are all shell, or <span class=
                    "application">Python</span> scripts used by package
                    <code class="filename">Makefile</code> scripts to
                    generate documentation for the package being built.
                  </p>
                </td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <p class="updated">
        Last updated on 2020-02-16 15:15:05 -0800
      </p>
    </div>
    <div class="navfooter">
      <ul>
        <li class="prev">
          <a accesskey="p" href="graphviz.html" title=
          "Graphviz-2.42.3">Prev</a>
          <p>
            Graphviz-2.42.3
          </p>
        </li>
        <li class="next">
          <a accesskey="n" href="hd2u.html" title="Hd2u-1.0.4">Next</a>
          <p>
            Hd2u-1.0.4
          </p>
        </li>
        <li class="up">
          <a accesskey="u" href="genutils.html" title=
          "Chapter&nbsp;11.&nbsp;General Utilities">Up</a>
        </li>
        <li class="home">
          <a accesskey="h" href="../index.html" title=
          "Beyond Linux� From Scratch     (System V Edition) - Version 9.1">Home</a>
        </li>
      </ul>
    </div>
  </body>
</html>
